Status and statistics endpoints

These endpoints give two views of Outbound automation: one count across every campaign in the account, and the detail of a single campaign.

Get the status of all campaigns

This endpoint counts the campaigns in the account, in total and per status. The campaigns behind these numbers are the ones List campaigns returns.

Endpoint

GET /api/v1/campaignDialer/status

Request

GET /api/v1/campaignDialer/status HTTP/1.1
Host: livehub.audiocodes.io
Authorization: Bearer {token}

Response

200 OK — the total, and a breakdown by status. For what each status means, see Campaign statuses.

{
  "campaignCount": 28,
  "status": {
    "notStarted": 2,
    "inProgress": 3,
    "locked": 0,
    "completed": 23
  }
}

Get the statistics of a campaign

This endpoint reports the progress of one campaign from two angles.

targetStatistics counts people: each target falls into exactly one category, either under completed or under notCompleted. callsStatistics counts call attempts, so a target that was retried appears more than once. For what each counter means, see Monitor campaign progress; the portal's Statistics tab shows the same set.

Endpoint

GET /api/v1/campaignDialer/campaigns/{campaignID}/statistics

Request

GET /api/v1/campaignDialer/campaigns/671e131f414a5fec9bced6e7/statistics HTTP/1.1
Host: livehub.audiocodes.io
Authorization: Bearer {token}

Response

200 OK — the counters.

{
  "targetStatistics": {
    "enabledTargets": 2,
    "disabledTargets": 0,
    "completed": {
      "dialerFailure": 0,
      "answeredBotFailure": 0,
      "answeredBotSuccess": 0,
      "answeredSuccess": 2
    },
    "notCompleted": {
      "notInitiated": 0,
      "duringCall": 0,
      "rescheduled": 0
    }
  },
  "callsStatistics": {
    "totalCallsGenerated": 2,
    "callsRescheduled": {
      "noAnswer": 0,
      "faxOrAnswerMachine": 0,
      "busy": 0,
      "declined": 0,
      "botConnectivityError": 0,
      "systemCAC": 0,
      "unspecifiedError": 0
    }
  }
}

400 Bad Request — no campaign with that ID.